• Go to https://github.com/KirstenStark/colab_r_github (find this link in the Zoom chat)
  • Select Code > Download Zip
• You can also do this via git from the command line:
  • Note that this will download in your “home” directory (which you can find out typing pwd)

git clone https://github.com/KirstenStark/colab_r_github

1. Structuring working directories: RStudio Projects
2. Dynamic document generation: RMarkdown
3. Version control: Git + GitHub
4. Package management: renv
5. Containerization: Docker
6. Where to start?

• Peikert, A., & Brandmaier, A. M. (2020). A Reproducible Data Analysis Workflow with R Markdown, Git, Make, and Docker. PsyArXiv Preprints. https://doi.org/10.31234/osf.io/8xzqy

• Andreas Brandmaier: “A Reproducible Data Analysis Workflow with R Markdown, Git, Make, and Docker”, talk at the Online Symposium on Reproducing Analyses in Biological Psychology, November 2020 (https://www.youtube.com/watch?v=nTVcMDVlyOI)
• Richard McElreath: “Science as Amateur Software Development”, talk at the Max Planck IT Community, August 2020 (https://www.youtube.com/watch?v=zwRdO9_GGhY)
• Russ Poldrack: “Toward a Culture of Computational Reproducibility”, talk at the Foundations of Biomedical Data Science, December 2020 (https://www.youtube.com/watch?v=XjW3t-qXAiE)

• What it does:
  • Allows working in multiple different contexts (projects), e.g. one for each experiment
  • Each project has its own working directory, workspace, history, and source documents
  • Each project is associated with a folder on your computer (= working directory)

• What it does:
  • Allows working in multiple different contexts (projects), e.g. one for each experiment
  • Each project has its own working directory, workspace, history, and source documents
  • Each project is associated with a folder on your computer (= working directory)

• Why it helps:
  • Have a separate, shareable working environment for each experiment
  • Keep all the files associated with a project together — data, scripts, results, figures
  • Work on multiple projects at once, each associated with its packages (and package versions), loaded data, etc.
  • Use only relative paths
  • Useful for version control

• In RStudio: File > New Project > …

• Relative paths: path separator characters vary across systems, anchor points differ depending on contexts
  • Use the here-package (Müller, 2020) to define relative paths within the project: read.csv(here::here("data", "file_I_want.csv"))

• What it does:
  • Creates dynamic documents with embedded chunks of code (R, Python, Julia, Stan, …), computed results , written text, etc. (= LaTeX)
  • Markdown-files can be exported to documents (docx, rtf), presentations, pdfs, websites (html), … e.g using the knitr (Xie, 2015, 2020) and tinytex (Xie, 2015, 2020; for pdfs)
  • R code is dynamically rendered, and can be given in separate chunks (’’‘{r}’’‘) or inline (’ r … ’)

• What it does:
  • Creates dynamic documents with embedded chunks of code (R, Python, Julia, Stan, …), computed results , written text, etc. (= LaTeX)
  • Markdown-files can be exported to documents (docx, rtf), presentations, pdfs, websites (html), … e.g using the knitr (Xie, 2015, 2020) and tinytex (Xie, 2015, 2020; for pdfs)
  • R code is dynamically rendered, and can be given in separate chunks (’’‘{r}’’‘) or inline (’ r … ’)

• Why it helps:
  • Simple language (\(\neq\) LaTeX)
  • Integrates directly with statistical software (RStudio)
  • Saves code AND output in one file
  • Reduces copy & paste errors: reported results consistent with actual results

• Installation: install.packages("rmarkdown") (Allaire et al., 2017)
• Install ‘knitr’ package for easy access: install.packages("knitr") (Xie, 2015, 2020)

• Installation: install.packages("rmarkdown") (Allaire et al., 2017)
• Install ‘knitr’ package for easy access: install.packages("knitr") (Xie, 2015, 2020)
• Open a markdown file (.Rmd): File > New File > R Markdown

• Installation: install.packages("rmarkdown") (Allaire et al., 2017)
• Install ‘knitr’ package for easy access: install.packages("knitr") (Xie 2015, 2020)
• Open a markdown file (.Rmd): File > New File > R Markdown

• You don’t have RStudio installed: install Pandoc (http://pandoc.org) before installing markdown ()
• Lengthy R code chunks: Install knitr-package (Xie, 2014, 2015, 2020) to customize chunks and knitting process
  • {r cache=TRUE,message=FALSE,warning=FALSE,results="hide", error = TRUE}
  • or use opts_chunk$set()-function
• Knit to pdf: You need a LaTeX-installation
  • TinyTeX (Xie, 2010) is a light-weight, cross-platform distribution (install.packages("tinytex"); tinytex::install_tinytex()))
  • Separate code chunks by a blank line
• Write and prepare APA journal articles: The Papaja-package (Aust & Barth, 2020) contains an R Markdown template for APA manuscripts, and helper functions to report results and generate tables in APA-style
• Knit older .R code files: Put #’ in front of any top-level prose, including the header, or use:

#/*
rmarkdown::render(input = rstudioapi::getSourceEditorContext()$path,
                  output_format = rmarkdown::github_document()),
                  knit_root_dir = getwd()) #*/

• What it does:
  • Tracks changes to files (data and code) over time: Sequence of “snapshots” (commits), organized in repositories
  • Allows to “go back in time”: Recall older versions or revert the entire project
  • Changes between commits can be compared
  • GitHub: Popular server for sharing materials (privately or publicly) and collaborating via git (also: GitLab and others)

• Why it helps:
  • Keep things organized and track changes
  • Clean up code
  • Language agnostic
  • (Remote) backup
  • Work together with collaborators (even simultaneously and in parallel: branches, merges, pull requests) - and your future self
  • Web interface for your project and to track issues
  • Easily connected e.g. to the Open Science Framework (https://osf.io)

• Register an account with GitHub: https://github.com/
• (Update R, RStudio, and your packages: update.packages(ask = FALSE, checkBuilt = TRUE))
• Is Git installed? Open your shell (“Terminal” in RStudio and on Mac, “Eingabeaufforderung” on Windows), and type: git --version. If “git: command not found”:
• Install Git - Mac: Mac automatically offers installing developer command line developer tools. Click “Install”. If you don’t get the offer, type: xcode-select --install. Restart R.
• Install Git - Windows: Install “Git Bash” (https://gitforwindows.org). Accept default settings. When asked about “Adjusting your PATH environment”, select “Git from the command line and also from 3-rd party software”. Restart R.
• Configure Git: In the (Git Bash) shell, type
  • git config --global user.name 'your name'
  • git config --global user.email 'email associated with your GitHub account'
  • git config --global --list (Check whether everything worked)
• Optional: Install a Git client. Find more info e.g. here: https://happygitwithr.com/git-client.html

• Vocabulary - Git:
  • Repo(sitory): Directory of files that Git manages holistically
  • Commit: Snapshot of all files in the repository, at a specific moment, each with a unique identifier (hash code or SHA) and description (commit message)
  • Diff: Set of differences between (any) two commits
  • Tag: Specific name for a certain snapshot (optional), e.g. “v1.0.3”, “preprint”, “submitted”

• Vocabulary - Git:
  • Repo(sitory): Directory of files that Git manages holistically
  • Commit: Snapshot of all files in the repository, at a specific moment, each with a unique identifier (hash code or SHA) and description (commit message)
  • Diff: Set of differences between (any) two commits
  • Tag: Specific name for a certain snapshot (optional), e.g. “v1.0.3”, “preprint”, “submitted”
• Vocabulary - GitHub
  • Push: Send your local Git commits to GitHub
  • Pull: Compare and update your local Git with GitHub
  • Merge conflict: Git can’t be certain how to jointly apply diffs from two commits to their common parent. Resolve by picking manually, avoid by pushing often.

• Go to https://github.com/ and log in
• Click on “New repository”
  • Decide between “private” or “public”. Initialize with a README. Accept default settings for everything else.
  • Click “Create repository”
  • Copy the URL

• Clone your repository to RStudio
  • File > New Project > Select “Version Control” > Select “Git” > Enter your repository URL: https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git

• GitHub: No long-term guarantee for availability of service (GitHub is commercial)
  • Mirror snapshots on HU servers/OSF/Zenodo/FigShare/…
• GitHub generally works better with non-proprietary (text) file formats (e.g., CSV) than with proprietary file formats (e.g., XLSX)
  • .md-files will be displayed like HTML
  • .csv-files will have a nice layout
  • README.md-files act like the landing page
  • Use internal links to refer to other files

• What it does:
  • Creates a project-specific library of packages in the project folder
    (instead of C:/Program Files/R/R-4.0.2/library or the like)
  • Overwrites install.packages() to install packages in this local library
  • Keeps track of package versions in the renv.lock file

• Why it helps:
  • Keeps package versions untouched by other projects
  • Allows you to revert to the previous state when an update has broken your analysis
  • Makes it easier to share package versions with your collaborators (e.g., via GitHub)
  • Can also keep track of Python packages

1. Install renv just like any other R package via install.packages(renv)
2. Open your project and initialize your project library via renv::init()
3. After successfully installing or a package, use renv::snapshot(). This will write the current version of all packages that are installed (and used) in the project to the lockfile.
4. If you want to revert to previous state (e.g., if an update to any of your packages has caused problems), use renv::restore()

Instead of step #2, you can also select “Use renv with this project” during project creation.

Restoring someone else’s package versions:

1. Clone or pull the repository from GitHub
2. Open the the RStudio project (e.g. via the projectname.Rproj file)
3. Use renv::restore() to install the package versions from the renv.lock file

• There may be some (inconsequential) warnings when switching between Mac and Windows
• Installing and loading packages may take a while, especially if your project lives on a network drive
  (such as N:/)
• For installing packages that are not on CRAN you can use remotes::install_github() and the like. Note, however, that at least on Windows, you may need to install additional tools for building these packages (via renv::equip() and/or from https://cran.r-project.org/bin/windows/Rtools/)

• What it does:
  • Creates a small, linux-based virtual machine on your computer
  • Makes it possible to run your scripts (or render your .Rmd files) on this virtual system
  • The recipe to build this system is stored in a Dockerfile that can be shared via GitHub

• Why it helps:
  • Prevents differences between operating systems, R versions, region and language settings etc.
  • Ensures long-term reproducibility
  • Provides a starting point for cloud-based and high perfomance computing (HPC)
  • Pre-packaged Docker images are available for different languages (R, Python, MATLAB, LaTeX etc.)

1. Install Docker from https://docs.docker.com/installation/ and run it
2. Select the appropiate Docker image (see https://hub.docker.com/search?q=rocker&type=image)
   • rocker/rstudio contains R and RStudio
   • rocker/tidyverse adds the tidyverse packages
   • rocker/verse adds LaTeX
3. From the terminal, run a Docker container based on this image:

docker run -e PASSWORD=1234 -p 8787:8787 -v /path/to/your/project:/home/rstudio/ rocker/rstudio

• -e PASSWORD=1234 -p 8787:8787 makes it possible to connect to RStudio (running in the container) from your web browser by opening http://localhost:8787 (username: rstudio, password: 1234)
• -v /path/to/your/project:/home/rstudio/ makes your project available within the container
• rocker/rstudio is the name of the Docker image you have chosen above

• You can get additional flexibility by creating your own Dockerfile
  • A Dockerfile is a text file which acts like a recipe to build your own Docker container
    (which you can then run)
  • It is based on an existing Docker image (e.g., rocker/verse)
  • It can contain additional lines of code to install software (e.g., renv::restore())
    or run scripts (e.g., rmarkdown::render(...))

• For detailled instructions, see Boettiger & Eddeulbuettel (2017) and
  Peikert & Brandmaier (2020)

# This as a text file stored with the name "Dockerfile" in your project directory.

# Base image from Docker Hub, including R, RStudio, the tidyverse, and LaTeX
FROM rocker/verse:4.0.2

# Set working directory within the container
WORDIR /home/rstudio

# Install renv
RUN R -e "remotes::install_version('renv', version = '0.12.0', repos = 'http://cran.us.r-project.org')"

# Copy the lock file
COPY renv.lock renv.lock

# Install package versions stored in the lockfile
RUN R -e "renv::consent(provided = TRUE)"
RUN R -e "renv::restore(prompt = FALSE)"

# When the container is run, render the report / mansucript
ENTRYPOINT Rscript -e "rmarkdown::render('my_manuscript.Rmd')"

• Docker is the basis for other tools for running analyses in the cloud or on high performance computing (HPC) clusters:
  • With binder (https://mybinder.org) and Code Ocean (https://codeocean.com), you can run your analysis in the cloud; they will even create the Dockerfile for you if you don’t have your own one
  • Singularity (https://sylabs.io) is a fully compatible, open source clone of Docker which you can use on systems where you don’t have root access (e.g., on HPC clusters)

• This wealth of tools can seem overwhelming
  • Adopting even one or two of them can help making your code more reproducbile
• An RStudio project and renv are easy to set up even for existing projects
  • And will help a lot to make sure that you can still run your code at re-submission
• Version control is best tried out with a new (real or toybox) project
  • Create an empty repository on GitHub and use it to create your RStudio project
• Once you’ve made it this far, full computational reproduciblity (by containerizing your project) is just one more step away

• Create a GitHub repository:
  • Go to https://github.com/. > Enter your username and password.
  • Click on “New” repository
    • Settings: Create a private repository (you can make it public later), add a README file, and accept the default settings for everything else.
  • Click on “Create repository”
  • Copy the URL
• Open R Studio and create an R project:
  • File > New Project… > Select “Version Control” > Select “Git”
  • Enter the URL you just copied (https://github.com/USERNAME/REPOSITORY-NAME), choose a project directory name, and where it should be saved.
  • Click on “Create Project”.
    • (Terminal alternative: ‘git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git’. Then ‘cd YOUR-REPOSITORY’)

• Make changes to your README file, commit, and push
  • Open your README file: File > Open File…
  • Make changes to your README file (e.g., type “This is my first GitHub repository”)
    • (Terminal alternative: ‘echo “YOUR-TEXT” >> README.md’)
  • Commit: Open the “Git” tab (next to the Environment) > Click on the “Commit” button > Stage your change > Enter a commit message > Click on “Commit”
  • Push to GitHub: Click on “Push”
    • (Terminal alternative: "git add -A’. Then ‘git commit -m “COMMIT-MESSAGE”’. Then ‘git push’)

• Install RMarkdown: Type to console install.packages("rmarkdown") and install.packages("knitr")
• Create an RMarkdown file:
  • File > New File > R Markdown… > Select “Document”
  • Choose a title (e.g. “analyses”) and HTML as the default output format > Click “OK”
• Make changes to your Markdown file: Enter a first section title (“# Random number generation”), a text (“Here, we generate 10 random numbers between 0 and 10”), and an R code chunk (Insert > R):

set.seed(1234)
numbers <- sample(0:10, 10, replace = FALSE)
print(numbers)

• Knit your Markdown file: Knit button
• Commit and push your change: Click on “Commit” > Stage files > Enter commit message > Click on “Commit” > Click on “Push”

• In the “Package” pane, check if you have renv installed
  • If not: install.packages("renv")
• Initialize your local project library by typing in the console: renv::init()
  • If you want to, take a look at the renv.lock from the “Files” pane in RStudio

• From the console, install a new package:

install.packages("cowsay")

• renv only keeps track of packages that are actually used in one or more of your scripts. Therefore, create a new code chunk in your RMarkdown file (Insert > R) and paste:

text <- paste("My favorite numbers are", numbers)
cowsay::say(text, "cow")

• Save and/or knit the file.
• Check the status of your project library by typing to the console: renv::status()
• You’ll notice that the cowsay package is not yet added to your lockfile. Do so by typing to the console: renv::snapshot()
• Commit and push your changes to GitHub. Congrats! You now have a reproducible project.